<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Base Parameter Element</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<h1>Parameter</h1>

<p>The base parameter element defines properties common to 
all types of parameters.</p>

<h3>Description</h3>

<p>The base parameter element defines 
properties common to all types of parameters. Parameters can be hidden, meaning 
that they will not appear in the UI. Parameters also provide additional pop-up 
help text that can explain the use of the parameter to the end user.</p>

<h3>Inherited Properties</h3>

<dl>
<dt class="inherited-property">name</dt>
<dd>The internal name of the parameter, inherited from 
Report Element. Expressions in the report reference the parameter using this 
name. The name must be unique among parameters and parameter groups. The user 
will see this name unless the display name is defined. The name cannot be 
externalized.</dd>
<dt class="inherited-property">extends</dt>
<dd>A parameter can extend a parameter defined in a 
library, but not another parameter defined within the report design.</dd>
<dt class="inherited-property">displayName</dt>
<dd>The prompt text to display in the UI. The display 
name can be externalized. If the display name is omitted, the Requester page 
will display the parameter name instead.</dd>
</dl>

<h3>See Also</h3>

<h2 class="property">hidden</h2>

<p>Hides the parameter from the parameter UI.</p>

<h3>Description</h3>

<p>If true, the parameter will not appear in the Requester 
page. Allows the developer to create parameters for internal use, or for use by 
scripts. Parameters are visible by default.</p>

<h3>See Also</h3>

<p><code>concealValue</code> property of 
the Scalar Parameter</p>

<h2 class="property">helpText</h2>

<p>Additional text to display for the parameter to explain how to use the parameter.</p>

<h3>Description</h3>

<p>Additional text to display for the parameter to explain 
how to use the parameter. The string can be externalized. </p>

<h3>See Also</h3>

<h2 class="property">helpTextID</h2>

<p>Resource key for the helpText</p>

<h3>Description</h3>

<p>helpText can be externalized. helpTextId is the resource key for the helpText. </p>

<h3>See Also</h3>

<h2 class="method">validate</h2>
<p>Validation method associated with the parameter</p>
<h3>Description</h3>
<p>User can implement this method to perform custom validation for a particular parameter. This method is called during report execution, to validate the parameter value. </p>
<h3>See Also</h3>

</body>
</html>